home *** CD-ROM | disk | FTP | other *** search
/ Nebula 2 / Nebula Two.iso / SourceCode / MiscKit1.7.1 / MiscKit / Examples / AutoDoc / README < prev   
Encoding:
Text File  |  1995-11-02  |  1.7 KB  |  39 lines

  1. Thu Nov  2 13:03:00 1995 - autodoc version 1.8.4 release notes: README
  2.  
  3.  
  4.  DESCRIPTION
  5.  
  6. Autodoc is a FREE utility that generates NEXTSTEP-style Rich Text Formatted documentation for Objective-C classes, categories and protocols by extracting comments imbedded in the source code files. Autodoc will also produce documentation for functions, definitions, macros, typedef's and global variables.
  7.  
  8. Autodoc is available for free. The latest release of Autodoc, v1.8.4, is available at ftp.friday.com.
  9.  
  10.  
  11.  BACKGROUND
  12.  
  13. Autodoc is a perl script originally developed by Adam Swift <aswift@friday.com> at Information Technology Solutions, it is now being maintained by Adam Swift and Bill Bumgarner for Friday Software and Consulting.  Autodoc has been donated free of charge to the Public Domain. 
  14.  
  15.  
  16.  SYSTEM REQUIREMENTS
  17.  
  18. In order to run Autodoc, you need to have perl v5.001 installed on your system. Perl is freely available from a number of places, but the most up to date version (precompiled tri-fat) is available from ftp.thoughtport.com thanks to Bill Bumgarner.
  19.  
  20.  
  21.  INSTALLATION
  22.  
  23. See the INSTALL file for information on installing and running Autodoc.  In general, previous Autodoc execution commands should work as they did before; however, the installation process is a little bit more involved because Autodoc has been split into modules.
  24.  
  25.  
  26.  RELEASE NOTES
  27.  
  28. See the CHANGES file for a summary of improvements since the last release.  Biggest changes: protocols, functions, constants, typedefs, globals, and macros are now documented.
  29.  
  30.  
  31.  OTHER STUFF
  32.  
  33. Mailing List: There is a low bandwidth autodoc mailing list: autodoc@friday.com.  To subscribe, send an empty message with the subject line, "subscribe", to <autodoc-request@friday.com>.
  34.  
  35.  
  36. Enjoy!
  37.  
  38. - adam
  39.